chore(mbe): add api-ts desc's for wallet creation and signings #93
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pranavjain97
force-pushed
the
WP-5355-dev-docs-wallet-creation-signing
branch
3 times, most recently
from
510ea69 to
88e7e29
Compare
pranavjain97
force-pushed
the
WP-5355-dev-docs-wallet-creation-signing
branch
from
88e7e29 to
017943a
Compare
Also adds walletVersion to the list of params. Ticket: WP-5335
pranavjain97
force-pushed
the
WP-5355-dev-docs-wallet-creation-signing
branch
2 times, most recently
from
1664afa to
d0b154f
Compare
pranavjain97
force-pushed
the
WP-5355-dev-docs-wallet-creation-signing
branch
from
d0b154f to
ef8e38d
Compare
pranavjain97
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Master BitGo Express API specification by extracting route definitions into separate files and moving types to dedicated route modules. The changes improve code organization and maintain functionality while adding comprehensive API documentation.
- Extracts individual route definitions from a large monolithic file into dedicated route files
- Moves type definitions from the main API spec to their respective route modules
- Adds comprehensive JSDoc documentation for all API endpoints and request/response types
Reviewed Changes
Copilot reviewed 14 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/api/master/routers/masterBitGoExpressApiSpec.ts | Refactored to import route definitions from separate files, removing hundreds of lines of inline definitions |
| src/api/master/routers/signAndSendMpcRoute.ts | New file containing MPC transaction signing route definition with documentation |
| src/api/master/routers/sendManyRoute.ts | New file containing send many transactions route with comprehensive parameter documentation |
| src/api/master/routers/recoveryRoute.ts | New file containing wallet recovery route with detailed recovery options for different coin types |
| src/api/master/routers/recoveryConsolidationsRoute.ts | New file containing recovery consolidations route for multi-address wallet recovery |
| src/api/master/routers/generateWalletRoute.ts | New file containing wallet generation route with detailed wallet and keychain type definitions |
| src/api/master/routers/consolidateUnspentsRoute.ts | New file containing UTXO consolidation route for unspent transaction outputs |
| src/api/master/routers/consolidateRoute.ts | New file containing address consolidation route for account-based assets |
| src/api/master/routers/accelerateRoute.ts | New file containing transaction acceleration route supporting CPFP and RBF methods |
| src/api/master/handlers/recoveryWallet.ts | Updated import path for moved recovery types |
| src/api/master/handlers/generateWallet.ts | Added request spreading to wallet parameters |
| src/tests/api/master/generateWallet.test.ts | Updated test expectations to match new response type structure |
| src/tests/api/master/eddsa.test.ts | Removed outdated TODO comment |
| masterBitgoExpress.json | Updated OpenAPI specification with enhanced documentation and error response codes |
| /** | ||
| * Common keychain of the wallet during wallet creation | ||
| */ | ||
| commonKeychain: t.string, |
There was a problem hiding this comment.
The commonKeychain field is defined as required in the object but optional in the response schema. According to the OpenAPI spec (line 884), this field is required, but the type definition allows it to be undefined. This inconsistency could cause validation issues.
| /** | ||
| * Required for transactions from MPC wallets. | ||
| */ | ||
| type: t.union([ |
There was a problem hiding this comment.
The type field includes values like 'fillNonce', 'acceleration', 'accountSet', 'enabletoken', 'transfertoken', and 'trustline' but the OpenAPI specification shows a different set of values that excludes 'stakingLock' and 'stakingUnlock'. This mismatch between the code and the generated specification could lead to client-side validation errors.
pranavjain97
requested review from
alextse-bg,
cpatino-intive and
mohammadalfaiyazbitgo
cpatino-intive
approved these changes
Aug 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket: WP-5355